Add Mermaid graph about ExUnit processes #14372
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Would a sequence diagram work better? http://mermaid.js.org/syntax/sequenceDiagram.html |
|
@josevalim maybe but I find it harder to read, while this looks really simple to me. I don't have a strong pref though :) |
sequenceDiagram
Runner->>Runner: setup_all
Runner->>Test Process #1: spawn
Test Process #1->>Test Process #1: setup
Test Process #1->>Test Process #1: run test
Test Process #1->>Runner: exit
Runner->>Runner: on_exit callbacks
Another one if you want to show multiple test processes: sequenceDiagram
Runner->>Runner: setup_all
Runner->>Test Process #1: spawn
Test Process #1->>Test Process #1: setup
Test Process #1->>Test Process #1: run test
Test Process #1->>Runner: exit
Runner->>Runner: on_exit callbacks
%% You may remove this later half
Runner->>Test Process #2: spawn
Test Process #2->>Test Process #2: setup
Test Process #2->>Test Process #2: run test
Test Process #2->>Runner: exit
Runner->>Runner: on_exit #2 callbacks
|
|
Let me get my Mermaid fu out then. You're on |
|
@josevalim jokes aside, this is the best I can do: sequenceDiagram
participant runner as ExUnit case runner
loop Each setup_all callback
runner->>runner: setup_all
Note over runner: In the order they're defined
end
loop Each test
create participant test1 as Test process 1
runner->>test1: Spawn
loop Each setup callback
test1->>test1: setup
Note over test1: In the order they're defined
end
test1->>test1: Run test
destroy test1
test1-xrunner: Test exits
loop Each on_exit
runner->>runner: on_exit
Note over runner: In the reverse order they're defined
end
end
It's very precise IMO, but I’m not sure it's legible. I'll let you choose between my first option, your (second option), and this third option. |
|
I like the loop! Here is a proposal between mine and yours: sequenceDiagram
participant runner as ExUnit Case
runner->>runner: Run setup_all callbacks
loop each test
create participant test as Test Process
runner->>test: Spawn
test->>test: Run setup callbacks
test->>test: Run test
destroy test
test-xrunner: Exits
runner->>runner: Run on_exit callbacks
end
I would be happy with shipping this one! |
|
@josevalim deal, I really like that 🙃 |
josevalim
approved these changes
Mar 27, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Looks like this:
This is 90% for me because I kind of always forget. Do we like it?